Reports: Balance Details

Reports: Balance Details (default RPTBALD via script) is the command that triggers the service to build a Balance Details report. Balance Details reports publish detailed station balances per Station Node within a specified date range, showing volume, energy, or mass values. Reported results are shown with a decimal precision of 7 places.

You must have proper security authorization to execute this command. See FMS Security (and CMDSYS security event) for information about configuring security access for FMS commands.

See Running Reports for more information about report-building options in CygNet Measurement.

See Using the Reports Control for more information about running reports via FMS Explorer.

See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands in CygNet Explorer.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See CxFms for more information about scripting commands.

Command Components

To build a report in CygNet Measurement, first use the following components to customize available report types, format, and content.

• Required: Report Template File

  See Managing Report Template Files and Balance Details Report Templates for more information about configuring report templates and using tokens to customize the Balance Details reports available in your system.

• Optional: Report Definition

  See Managing Report Definitions and Balance Details Report Definitions for more information about configuring report definitions in FMS Explorer to additionally customize Balance Details report type options available in your workspace.

Command Definition Properties

The following command definition properties apply to Reports: Balance Details commands, when scheduling, creating, or editing commands via CygNet Explorer.

Property	Description
FMS service	Select a Site.Service for the command from the available FMS service list in the drop-down menu.
Command	Select the desired Command name from the drop-down menu. See FMS Commands for more information about available command types.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low — displays errors Medium — displays errors and warnings High — displays errors, warnings, and status Default value is Low level logging when scheduling a command via the MSS in CygNet Explorer. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS in CygNet Explorer.

Command Parameters

The following command parameters apply to Reports: Balance Details commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.

Parameter	Description	Type	Usage Notes
RptFileNm	Report file name	File Name	Double-click to access the Select Report File Name dialog box. Type a file name for the report into the text box. Tokens can also be used to define a report file name. Note: This is the name of the report file, not the report title. This parameter is required.
RptPath	Report file directory	File Directory	If used, double-click to access the Enter Report File Directory dialog box. Type the directory location for the report file into the text box or click ... to access the Browse for Folder dialog box, browse to the directory location. Note: The directory specified is relative to the computer hosting the FMS. This parameter is optional.
RptEmail	Email distribution list	String	If used, double-click to access the Enter Email Distribution List dialog box. Type a list of recipients' email addresses into the text box, separated by commas. Note: Use commas to separate recipients in the list; semicolons are not acceptable characters. This parameter is optional.
RptFileTp	Report file type	String Enum	Double-click to access the Report File Type dialog box. Select the file format from the options in the drop-down menu. Options are as follows. XLSX (XLSX via script) PDF (PDF via script) This parameter is required.
RptStDate	Start date	Date	Date selections are in Contract days (C). Double-click to access the Select Start Date dialog box. Select the starting date of the time range to include in the report. Note: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). See Selecting Date and Time for more information. This parameter is required. Note: This parameter will not appear if it has been specified in the report template.
RptEndDate	End date	Date	Date selections are in Contract days (C). Double-click to access the Select End Date dialog box. Select the ending date of the time range to include in the report. Note: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). See Selecting Date and Time for more information. This parameter is required. Note: This parameter will not appear if it has been specified in the report template.
RptUnitSet	Unit set	Dynamic String Enum	Double-click to access the Unit Set dialog box. Select a unit set in which to view the data. Options appear in the drop-down menu, which is populated by the unit sets defined in the service. See Configuring Unit Set Definitions for more information. This parameter is required. Note: This parameter will not appear if it has been specified in the report template.

Defining a Report File Name

You can use text, tokens, or both, to define a report file name in the MSS. A token is a text string enclosed by percent signs (%sampletext%), which represents a described value. The token will be replaced with the value it represents. Tokens are used several places in CygNet Software to define dynamic text substitutions, as described for the specific usage.

To Define a Report File Name in the MSS

1. Double-click the Report file name parameter to access the Select Report File Name dialog box.

Select Report File Name

2. Enter a file name using one of the following methods.

1. Type the file name directly into the text box.
2. Use tokens to define the file name. Acceptable token string options appear in the list box. Double-click a token name to add it to the file name in the text box. Repeat for all desired tokens. Cut and paste to alter token order, if desired.
3. Use tokens in conjunction with typed text to define the file name. Text can be located before, between, or after tokens.

3. Click OK when you are done.